home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / gnustuff / tos / othergnu / texinf~1.zoo / texinfo.st / README.bin < prev    next >
Encoding:
Text File  |  1993-06-29  |  4.0 KB  |  79 lines
  1. This set of programs provides an (updated) ST port for FSF system of
  2. documentation called `Texinfo'.  Documents prepared in this system can
  3. be either typeset in a book form (with TeX, but also with troff), or
  4. displayed on-line with hypertext capabilities on character based
  5. terminals.
  6.  
  7. The following programs are included:
  8.   - makeinfo.ttp    a formatter with an output in .info format,
  9.                     which is accepted by info.ttp viewer
  10.   - info.ttp        hypertext viewer for .info files
  11.   - texindex.ttp    index formatter for Texinfo files printed with TeX
  12.   - texi2roff.ttp   converter into [tn]roff format for Texinfo files
  13.   - texi2index      Bourne shell script for making indices for troff.
  14.  
  15. Programs `makeinfo' and `texindex' come from the current (3.1) Texinfo
  16. distribution.  Unfortunately `info' from the same set, although
  17. provides many new capabilities, is considered "beta".  This really
  18. means that it is so far quite buggy and has obvious "memory stomping"
  19. problems.  Therefore info.ttp was compiled from modified and fixed
  20. texinfo-2.16 sources.  `texi2roff' is originally distributed
  21. separately and texi2roff-2.0 served as a basis for this port.
  22.  
  23. Original complete sources are on a bigger side and contain, among
  24. other things, over .5 Meg of documentation and other goodies.  If you
  25. are seriously interested in Texinfo you should consider retrieving
  26. them from usual archives which carry GNU software.  prep.ai.mit.edu is
  27. one of location.  Modified ST sources for C programs only are also
  28. posted to comp.sources.atari.st and to an archive at
  29. atari.archive.umich.edu (and its mirrors).
  30.  
  31. Together with a distribution are included sample Texinfo files
  32. info.txi, makeinfo.txi and, courtesy of Frank Ridderbusch, gcc-st.txi.
  33. If you never tried info before start simply running makeinfo.ttp and
  34. giving it as an argument these files - one at at time.  Then, without
  35. changing directory, type 'info', and once info will start follow on
  36. screen instructions.  Sample `dir' file has all neccessary entries.
  37. You may add to it your own files later following pretty obvious
  38. format.  All these files (dir and .inf) later can be put in any
  39. directory listed in INFOPATH.  This environment variable has a
  40. compiled in default value of `.,c:\gnu\info' but you may set it
  41. explicitely to whatever you want. Slash and backslash as path elements
  42. separators are treated in an equivalent manner.  Other usual ST
  43. conventions for path specifications are also recognized.  Try also
  44. running makeinfo giving it options of `--no-split --no-headers' and
  45. scrutinize results.
  46.  
  47. Files produces by makeinfo on ST and on a Unix machine are
  48. interchangable with an exception of "external" names, which had to be
  49. squeezed on ST into an 8+3 scheme.  Internally they are the same.
  50. Also info.ttp will not distinguish between info files with CR/LF line
  51. terminators, or only LF.  On Unix side you will have to remove
  52. superfluous carriage returns.  This means that you can "borrow" ready
  53. info files from your nearest Unix machine (modifying names in an
  54. obvious, upon examination, way).  On the other hand, I successfully
  55. formatted on Mega with 2.5 Megs of memory the full 550 K of an
  56. original Texinfo manual (this required separate run with
  57. `--only-split' to divide into parts a monolitic .inf file from the
  58. first run).
  59.  
  60. Enjoy,
  61. Michal Jaegermann
  62. ntomczak@vm.ucs.ualberta.ca
  63. michal@gortel.phys.ualberta.ca
  64.  
  65. Note about findfile():
  66. info and makeinfo, as provided, use a modified findfile() function
  67. which is using comma and colon for path separators, but a colon which
  68. follow a single letter opening path element and followed by a slash or
  69. backslash is taken literally.  That means that in these executables
  70. path specifications like
  71.      c:/tmp:c:/lib/info
  72.      c:\tmp,c:\lib\info
  73.      /dev/c/tmp:/dev/c/lib/info
  74. are all equivalent.  If you really want to specify in your path
  75. subdirectory 'c' of your current directory and which is followed by
  76. other path entries (not likely, but maybe) use then './c' or '.\c' as
  77. its name.  Otherwise confusion will follow.  If for some reasons
  78. you are unhappy with this convention you will have to recompile.
  79.